Other Classes
The following classes are available globally.
-
Options for calculating results from the Mapbox Directions service.
You do not create instances of this class directly. Instead, create instances of
See moreMatchOptions
orRouteOptions
.Declaration
Swift
open class DirectionsOptions : Codable
extension DirectionsOptions: Equatable
-
A
DirectionsResult
represents a result returned from either the Mapbox Directions service.You do not create instances of this class directly. Instead, you receive
See moreRoute
orMatch
objects when you request directions using theDirections.calculate(_:completionHandler:)
orDirections.calculateRoutes(matching:completionHandler:)
method.Declaration
Swift
open class DirectionsResult : Codable
extension DirectionsResult: CustomStringConvertible
-
An instruction about an upcoming
RouteStep
’s maneuver, optimized for speech synthesis.The instruction is provided in two formats: plain text and text marked up according to the Speech Synthesis Markup Language (SSML). Use a speech synthesizer such as
AVSpeechSynthesizer
or Amazon Polly to read aloud the instruction.The
See moredistanceAlongStep
property is measured from the beginning of the step associated with this object. By contrast, thetext
andssmlText
properties refer to the details in the following step. It is also possible for the instruction to refer to two following steps simultaneously when needed for safe navigation.Declaration
Swift
open class SpokenInstruction : Codable
extension SpokenInstruction: Equatable
-
The contents of a banner that should be displayed as added visual guidance for a route. The banner instructions are children of the steps during which they should be displayed, but they refer to the maneuver in the following step.
See moreDeclaration
Swift
open class VisualInstruction : Codable
extension VisualInstruction: Equatable